MarkLogic 12 Product Documentation

PUT /manage/v2/databases/{id|name}/partitions/{name}/properties

Summary

Modify the configuration of the partition identified by {name} in the database identified by {id|name}.

Response

Upon success, MarkLogic Server returns a status code 204 (No Content).

Required Privileges

http://marklogic.com/xdmp/privileges/manage-admin

Usage Notes

You can set the property values as follows:

• availability: Set the availability of the partion to either online or offline. For details, see tieredstorage:partition-set-availability.
• updates-allowed: Set the updates-allowed state for the partition to one of the following: all, delete-only, read-only, flash-backup. For details, see tieredstorage:partition-set-updates-allowed.

For details, see Common Forest and Partition Operations in the Administrator's Guide.

availability

Availability of the forest data.

updates-allowed

The kinds of updates that should be allowed for this forest.

query-exclusion

Example

$ cat partition-prop.xml
==> 
<partition-properties xmlns="http://marklogic.com/manage">
  <availability>online</availability>
  <updates-allowed>all</updates-allowed>
</partition-properties>

$ cat partition-prop.json
==> 
{
  "availability": "online",
  "updates-allowed": all"
}

$ curl --anyauth --user user:password -X PUT -d @./partition-prop.xml \
    -i -H "Content-type: application/xml" \
    http://localhost:8002/manage/v2/databases/example-db/partitions/2011/properties

==> Set the availability and updates-allowed properties of the partition
    named 2011 of the database example-db. MarkLogic Server responds
    with status code 204 (No Content) and headers similar to the following:

HTTP/1.1 204 No Content
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5